Skip to content

fix(external docs): render all top level configuration fields#24863

Merged
pront merged 14 commits intomasterfrom
pront-fix-top-level-vector-config-website-page
Mar 9, 2026
Merged

fix(external docs): render all top level configuration fields#24863
pront merged 14 commits intomasterfrom
pront-fix-top-level-vector-config-website-page

Conversation

@pront
Copy link
Member

@pront pront commented Mar 6, 2026

Summary

  • Removes hacky global_option(...) workaround (logic moved in a single place, scripts/generate-component-docs.rb)
  • Introduces config pages for other top level config fields that were previously undocumented
  • Removes special handling of docs exclusions, now we can use #[configurable(metadata(docs::hidden))] like in other components
  • Adds docs for schema options
  • Better navigation: Sidebar now expands when clicking on "Configuration" to show all sub-pages

Vector configuration

How did you test this PR?

Change Type

  • Bug fix
  • New feature
  • Dependencies
  • Non-functional (chore, refactoring, docs)
  • Performance

Is this a breaking change?

  • Yes
  • No

Does this PR include user facing changes?

  • Yes. Please add a changelog fragment based on our guidelines.
  • No. A maintainer will apply the no-changelog label to this PR.

References

Related: #21735

Notes

  • Please read our Vector contributor resources.
  • Do not hesitate to use @vectordotdev/vector to reach out to us regarding this PR.
  • Some CI checks run only after we manually approve them.
    • We recommend adding a pre-push hook, please see this template.
    • Alternatively, we recommend running the following locally before pushing to the remote branch:
      • make fmt
      • make check-clippy (if there are failures it's possible some of them can be fixed with make clippy-fix)
      • make test
  • After a review is requested, please avoid force pushes to help us review incrementally.
    • Feel free to push as many commits as you want. They will be squashed into one before merging.
    • For example, you can run git merge origin master and git push.
  • If this PR introduces changes Vector dependencies (modifies Cargo.lock), please
    run make build-licenses to regenerate the license inventory and commit the changes (if any). More details here.

@github-actions github-actions bot added domain: external docs Anything related to Vector's external, public documentation domain: core Anything related to core crates i.e. vector-core, core-common, etc labels Mar 6, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2026

Your preview site for the vector.dev will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
vector.dev preview

@pront pront changed the title fix(docs): render all top level configuration fields fix(external docs): render all top level configuration fields Mar 6, 2026
@pront pront added the no-changelog Changes in this PR do not need user-facing explanations in the release changelog label Mar 6, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Mar 7, 2026

Your preview site for the vector.dev will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
vector.dev preview

@pront pront marked this pull request as ready for review March 9, 2026 13:25
@pront pront requested review from a team as code owners March 9, 2026 13:25
@github-actions
Copy link
Contributor

github-actions bot commented Mar 9, 2026

Your preview site for the vector.dev will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
vector.dev preview

@github-actions
Copy link
Contributor

github-actions bot commented Mar 9, 2026

Your preview site for the vector.dev will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
vector.dev preview

@github-actions
Copy link
Contributor

github-actions bot commented Mar 9, 2026

Your preview site for the vector.dev will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
vector.dev preview

Copy link
Contributor

@thomasqueirozb thomasqueirozb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice improvements!

@github-actions
Copy link
Contributor

github-actions bot commented Mar 9, 2026

Your preview site for the vector.dev will be ready in a few minutes, please allow time for it to build.

Heres your preview link:
vector.dev preview

@pront pront enabled auto-merge March 9, 2026 18:30
@pront pront added this pull request to the merge queue Mar 9, 2026
Merged via the queue into master with commit 79999f6 Mar 9, 2026
59 checks passed
@pront pront deleted the pront-fix-top-level-vector-config-website-page branch March 9, 2026 19:26
@github-actions github-actions bot locked and limited conversation to collaborators Mar 9, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

domain: core Anything related to core crates i.e. vector-core, core-common, etc domain: external docs Anything related to Vector's external, public documentation no-changelog Changes in this PR do not need user-facing explanations in the release changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants